MMA68xx.h

Go to the documentation of this file.

#ifndef _MMA68XX_H
#define _MMA68XX_H
 
/*
 **************************************************************
 * Defines, Macros and Typedefs 
 **************************************************************/
/*** Constant Macros ***/
/* Default Yes and No defines */
#ifndef TRUE
 #define TRUE (1u)
#endif
#ifndef CLEAR
 #define CLEAR (0u)
#endif
#ifndef BITS_IN_NIBBLE
 #define BITS_IN_NIBBLE (4u)
#endif
#ifndef BITS_IN_BYTE
 #define BITS_IN_BYTE (8u)
#endif
#ifndef BYTES_IN_16
 #define BYTES_IN_16  (2u)
#endif
#ifndef BYTES_IN_32
 #define BYTES_IN_32  (4u)
#endif
#ifndef BIT_DEFINITION
 #define BIT_DEFINITION
 #define BIT0  (1u << 0u)
 #define BIT1  (1u << 1u)
 #define BIT2  (1u << 2u)
 #define BIT3  (1u << 3u)
 #define BIT4  (1u << 4u)
 #define BIT5  (1u << 5u)
 #define BIT6  (1u << 6u)
 #define BIT7  (1u << 7u)
 #define BIT8  (1u << 8u)
 #define BIT9  (1u << 9u)
 #define BIT10 (1u << 10)
 #define BIT11 (1u << 11)
 #define BIT12 (1u << 12)
 #define BIT13 (1u << 13)
 #define BIT14 (1u << 14)
 #define BIT15 (1u << 15)
 #define BIT16 (1u << 16)
 #define BIT17 (1u << 17)
 #define BIT18 (1u << 18)
 #define BIT19 (1u << 19)
 #define BIT20 (1u << 20)
 #define BIT21 (1u << 21)
 #define BIT22 (1u << 22)
 #define BIT23 (1u << 23)
 #define BIT24 (1u << 24)
 #define BIT25 (1u << 25)
 #define BIT26 (1u << 26)
 #define BIT27 (1u << 27)
 #define BIT28 (1u << 28)
 #define BIT29 (1u << 29)
 #define BIT30 (1u << 30)
 #define BIT31 (1u << 31)
#endif


/* Register Addresses for the device */
#define MMA6800_MEMORY_MAP_SIZE     (0x18u)
#define MMA6800_SN0                 (0x00u << 8u)
#define MMA6800_SN1                 (0x01u << 8u)
#define MMA6800_SN2                 (0x02u << 8u)
#define MMA6800_SN3                 (0x03u << 8u)
#define MMA6800_STDEFL_X            (0x04u << 8u)
#define MMA6800_STDEFL_Y            (0x05u << 8u)
#define MMA6800_FCTCFG_X            (0x06u << 8u)
#define MMA6800_FCTCFG_Y            (0x07u << 8u)
#define MMA6800_PN                  (0x08u << 8u)
#define MMA6800_RESERVED3           (0x09u << 8u)
#define MMA6800_DEVCTL              (0x0Au << 8u)
#define MMA6800_DEVCFG              (0x0Bu << 8u)
#define MMA6800_DEVCFG_X            (0x0Cu << 8u)
#define MMA6800_DEVCFG_Y            (0x0Du << 8u)
#define MMA6800_ARMCFGX             (0x0Eu << 8u)
#define MMA6800_ARMCFGY             (0x0Fu << 8u)
#define MMA6800_ARMT_XP             (0x10u << 8u)
#define MMA6800_ARMT_YP             (0x11u << 8u)
#define MMA6800_ARMT_XN             (0x12u << 8u)
#define MMA6800_ARMT_YN             (0x13u << 8u)
#define MMA6800_DEVSTAT             (0x14u << 8u)
#define MMA6800_COUNT               (0x15u << 8u)
#define MMA6800_OFF_CORR_X          (0x16u << 8u)
#define MMA6800_OFF_CORR_Y          (0x17u << 8u)

#define MMA6800_PCM_ON              (0x10u)
#define MMA6800_ARM_MOVEAVGHIGH     (0x20u)
#define MMA6800_ARM_MOVEAVGLOW      (0x21u)
#define MMA6800_ARM_COUNTHIGH       (0x30u)
#define MMA6800_ARM_COUNTLOW        (0x31u)
#define MMA6800_ARM_UNFILTHIGH      (0x40u)
#define MMA6800_ARM_UNFILTTLOW      (0x41u)

/* Register related */
#define MMA6800_READ_REGISTER       (0x00u)
#define MMA6800_WRITE_REGISTER      (0x40u)

/* Accel reading function masks */
#define MMA6800_READ_X               (BIT0)
#define MMA6800_READ_Y               (BIT1)

/* Accel reading settings */
#define MMA6800_READ_ACCEL           (0x2000u)
#define MMA6500_READ_ACCEL           (0x2008u)
#define MMA6800_X_AXIS               (0x0000u)
#define MMA6800_Y_AXIS               (0x4000u)
#define MMA6800_ARM_ENABLE           (0x0002u)
#define MMA6800_ARM_DISABLE          (0x0000u)
#define MMA6800_SIGNED_DATA          (0x0000u)
#define MMA6800_UNSIGNED_DATA        (0x0004u)
#define MMA6800_OFFSET_CANCELLED     (0x0000u)
#define MMA6800_RAW_DATA             (0x1000u)

/* Transfer mode definitions for MMA6800 */
#define MMA6800_TRANSFER_MODE_IS_SCHEDULED (0u)
#define MMA6800_TRANSFER_MODE_IS_IMMEDIATE (1u)

/* Error bits */
#define MMA6800_REGISTER_RESP_SIGNATURE (BIT11 | BIT10)
#define MMA6800_ACCEL_READING           (0x01u)
#define MMA6800_REGISTER_RESPONSE       (0x02u)
#define MMA6800_TIMED_OUT               (0x04u)
#define MMA6800_INVALID_PARITY          (0x08u)
#define MMA6800_INVALID_MEMORY_LOCATION (0x10u)
#define MMA6800_ERROR_DATAGRAM          (0x20u)
#define MMA6800_ERROR_ACCEL             (0x40u)

/* Mesquite or Sycamore */
#define MESQUITE 1
#define SYCAMORE 2

/* To filter out acceleration */
#define MMA6800_RAW_ACCEL_MASK          (0x03FFu)
#define MMA6500_RAW_ACCEL_MASK          (0xC3FFu)

/* Global buffer size */
#define MMA6800_GLOBAL_BUFFER_SIZE      (30u)

/* Error codes */
#define MMA6800_ERROR_MASK         ((uint16_t)0x6000u)

#define MMA6800_MSG_BUFFER_SIZE     50

/* This define counts how many elements are needed for */
/* an accel response given the number of elements sent */
/* as a request                                        */
#define RAW_MMA_ACCEL_ARRAY_SIZE    3u

/*** Function Macros ***/
#ifndef N_ELEMENTS
 #define N_ELEMENTS(X)           (sizeof(X)/sizeof(*(X)))
#endif

/*** Enums ***/

/*** TypeDefs ***/

/*
 **************************************************************
 * Declarations 
 **************************************************************/
/*** Extern ***/
extern const uint16_t cau16MMA6800ReadAllRegisters[];
extern const uint16_t cau16MMA6800Reset[];
extern const uint16_t cau16MMA6800PerformAccelReading[];
extern const uint16_t cau16MMA6500PerformAccelReading[];
extern uint8_t (* const u8pfnMMA6800BatchOp[])(const uint8_t cu8DSPIInstance,
    const uint8_t cu8ChipSelect,
    const uint16_t* pu16DataToSend,
    uint16_t* pu16UnfilteredDataReceived,
    uint8_t u8Size);
/*** Globals ***/
extern uint8_t gau8MMA6800GlobalResult[MMA6800_GLOBAL_BUFFER_SIZE];
/*** Static Globals ***/
/*
 **************************************************************
 * Function Prototypes 
 **************************************************************/
/*
 ******************************************************************************
 *
 * Function:          u8fnMMA6800ReadRegister()
 *
 */
uint8_t u8fnMMA6800ReadRegister(const uint8_t cu8DSPIInstance,
                                const uint8_t cu8ChipSelect,
                                const uint8_t cu8TransferMode,
                                uint16_t u16Register,
                                uint16_t* pu16DataRead);
/*
 ******************************************************************************
 *
 * Function:          u8fnMMA6800WriteRegister()
 *
 */
uint8_t u8fnMMA6800WriteRegister(const uint8_t cu8DSPIInstance,
                                 const uint8_t cu8ChipSelect,
                                 const uint8_t cu8TransferMode,
                                 uint16_t u16Register,
                                 uint8_t u8ValueToWrite, 
                                 uint16_t* pu16DataRead);
/*
 ******************************************************************************
 *
 * Function:          u8fnMMA6800Reset()
 *
 */
uint8_t u8fnMMA6800Reset(const uint8_t cu8DSPIInstance,
                         const uint8_t cu8ChipSelect, 
                         const uint8_t cu8TransferMode);
/*
 ******************************************************************************
 *
 * Function:          u8fnMMA6800ReadAccel()
 *
 */
uint8_t u8fnMMA6800ReadAccel(const uint8_t cu8DSPIInstance,
                             const uint8_t cu8ChipSelect,
                             const uint8_t cu8TransferMode,
                             const uint8_t cu8Axis,
                             const uint8_t cu8ConfigMemory,
                             uint16_t* pu16AccelResults, 
                             const uint8_t cu8Accel);
/*
 ******************************************************************************
 *
 * Function:          u8fnMMA6800ExtractRegisterResponse()
 *
 */
uint8_t u8fnMMA6800ExtractRegisterResponse(const uint16_t* pu16RawResponse, \
                                           uint8_t* pu8Response,            \
                                           uint8_t u8Size);
/*
 ******************************************************************************
 *
 * Function:          u8fnMMA6800ExtractAccelResponse()
 *
 */
uint8_t u8fnMMA6800ExtractAccelResponse(const uint16_t* pu16RawResponse, 
                                        uint16_t* pu16Response,          
                                        uint8_t u8Size,                  
                                        const uint8_t cu8Accel);
/*
 ******************************************************************************
 *
 * Function:          u8fnMMA6800ResponseAnalysis()
 *
 */
static uint8_t u8fnMMA6800ResponseAnalysis(uint16_t u16RawResponse);
/*
 ******************************************************************************
 *
 * Function:          u8fnMMA6800ErrorResponseAnalysis()
 *
 */
static uint8_t u8fnMMA6800ErrorResponseAnalysis(const uint16_t cu16ReceivedWord);
/*
 ******************************************************************************
 *
 * Function:          u16fnMMA6800AddParityToCommand()
 *
 */
static uint16_t u16fnMMA6800AddParityToCommand(uint16_t u16RawCommand);
/*
 ******************************************************************************
 *
 * Function:          u8fnMMA6800BatchOp()
 *
 */
uint8_t u8fnMMA6800BatchOp(const uint8_t cu8DSPIInstance,        \
                           const uint8_t cu8ChipSelect,          \
                           const uint16_t* pu16DataToSend,       \
                           uint16_t* pu16UnfilteredDataReceived, \
                           uint8_t u8Size);
/*
 ******************************************************************************
 *
 * Function:          u8fnMMA6800ScheduleBatchOp()
 *
 */
uint8_t u8fnMMA6800ScheduledBatchOp(const uint8_t cu8DSPIInstance, 
                                    const uint8_t cu8ChipSelect,   
                                    const uint16_t* pu16DataToSend,
                                    uint16_t* pu16UnfilteredDataReceived, uint8_t u8Size);

#endif /* _FILENAME_H */